Conversation
Updated README to enhance structure, add installation instructions, and improve content clarity.
|
Very nice! I would also add Pytorch Ecosystem Blog as a badge. It would be nice to have it there. Minor things:
|
Added badges for documentation, tutorial, version, license, and downloads to enhance README visibility.
Added an image and installation section to the README.
Added details and summaries for installation and quick tour sections in README.
Updated README.md to enhance documentation and structure.
GiovanniCanali
left a comment
GiovanniCanali
left a comment
There was a problem hiding this comment.
Hi @ndem0! I know this is still a work in progress, but you can find some suggestions below.
GiovanniCanali
left a comment
GiovanniCanali
left a comment
There was a problem hiding this comment.
Everything looks good, aside from a few minor points listed below. I’m unsure whether the API scheme should be fixed here or in a separate context, but it likely doesn’t affect this PR.
|
|
||
| <p style="max-width: 800px; font-size: 1rem; line-height: 1.5;"> | ||
| <b>PINA</b> is an open-source Python library designed to simplify and accelerate the development of | ||
| <b>Scientific Machine Learning</b> (SciML) solutions, including <b>PINNs</b>, Neural Operators, |
There was a problem hiding this comment.
Why is only “PINN” highlighted in bold? This could be misleading, as the software has broader applications.
| <h2>Getting started with PINA</h2> | ||
| | ||
| <a href="https://mathlab.github.io/PINA/"> | ||
| <img align="center" height="20" src="https://img.shields.io/badge/documentation-fa9900?style=for-the-badge&logo=readthedocs&labelColor=555"> |
There was a problem hiding this comment.
When rendered, a _ appears between the two badges. I can’t find this character in the source, so I’m not sure where it’s coming from.
3 participants
Updated README to enhance structure, add installation instructions, and improve content clarity.
Description
Just a README revamping to fix the logo problem on PyPI and to a "News" section
This PR fixes #725
Checklist